home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / misc / xref_v1.1.lha / XRef / Doc / english / expungexref.doc < prev    next >
Encoding:
Text File  |  1995-01-09  |  1.4 KB  |  54 lines
  1. XRef-Tools/ExpungeXRef                                   XRef-Tools/ExpungeXRef
  2.  
  3. $VER: expungexref.doc 1.7 (24.09.94)
  4.  
  5. NAME
  6.     ExpungeXRef - expunge a given file,category or all xreffiles
  7.  
  8. TEMPLATE
  9.     CATEGORY,FILE/K,FORCE/S,VERBOSE/S
  10.  
  11. FORMAT
  12.     ExpungeXRef [[CATEGORY] category] [FILE xreffile] [FORCE] [VERBOSE]
  13.  
  14. FUNCTION
  15.     this command expunges a/some xreffiles from memory.If no category or
  16.     file is specified all xreffiles are removed. If you turn on the switch
  17.     FORCE, xreffiles are also removed, which are locked.
  18.  
  19. INPUTS
  20.     CATEGORY (STRING) - category of xreffiles to expunge. Can be a pattern.
  21.  
  22.     FILE (STRING) - only expunge the file given here
  23.  
  24.     FORCE (BOOLEAN) - expunge also such files, which are protected via the
  25.         LOCK mechanism
  26.  
  27.     VERBOSE (BOOLEAN) - show each file, which is expunged !
  28.  
  29. EXAMPLE
  30.     the following example expunges only the xreffile mytools.xref in the
  31.     global xref drawer , even it is locked or not :
  32.  
  33.        ExpungeXRef FILE mytools.xref FORCE
  34.  
  35. SEE ALSO
  36.     LoadXRef, xref.library/XR_ExpungeXRef(), xref.library/XR_LoadXRef()
  37.  
  38. HISTORY
  39.     ExpungeXRef 1.7 (24.9.94) :
  40.         - now displays xreffiles, which aren't expunged due to a lock
  41.  
  42.     ExpungeXRef 1.6 (7.9.94) :
  43.         - workbench support added
  44.  
  45.     ExpungeXRef 1.5 (3.9.94) :
  46.         - VERBOSE option added
  47.  
  48.     ExpungeXRef 1.4 (6.7.94) :
  49.         - xref.library function names changed
  50.  
  51.     ExpungeXRef 1.3 (28.5.94) :
  52.         - FILE argument added
  53.  
  54.